home
***
CD-ROM
|
disk
|
FTP
|
other
***
search
/
BBS Toolkit
/
BBS Toolkit.iso
/
doors_2
/
wedit200.zip
/
WEDIT.DOC
< prev
next >
Wrap
Text File
|
1991-12-04
|
36KB
|
1,423 lines
Window Editor
───────────────
Version 2.0 - December 1991
Message Editor FTS-standard compliant
(C) Copyright 1991 Franco Schinco, FidoNet 2:334/100.0
Documentation by: Franco Schinco, FidoNet 2:334/100.0
Stefania Falleni, FidoNet 2:334/101.0
WEdit 2.0 - Copyright 1991 Franco Schinco 12/04/91
INDEX
1. INTRODUCTION...............................................1
2. THANKS.....................................................2
3. USAGE LICENSE..............................................3
4. INSTALLATION...............................................4
5. CONFIGURATION..............................................5
File.....................................................5
Prog. Info..........................................5
Write to............................................5
DOS Shell...........................................5
Exit................................................5
Global...................................................6
Key.................................................6
User................................................6
Address - Main......................................6
Address - Aka 1-10..................................6
Domain..............................................6
Directories - Msg Base..............................6
Directories - UserList..............................6
Directories - Nodelist..............................7
Directories - Swap..................................7
Directories - TossLog...............................7
Directories - EchoFile..............................7
Origin...................................................7
Origin 1 - 10.......................................7
Area.....................................................8
Area - Title........................................8
Area - Path/Board...................................8
Area - Kind.........................................8
Area - Default Attributes...........................8
Area - Aka..........................................8
Area - Origin.......................................8
Area - Tag..........................................8
Miscellaneous............................................9
Macro 1 - 10........................................9
Shell 1 - 10........................................9
Swap................................................9
Scan Areas..........................................9
No Sound............................................9
Use Domains.........................................9
Translate...........................................9
Tear line..........................................10
PID line...........................................10
Upcase Name........................................10
Quote Line.........................................10
6. EXECUTION.................................................11
7. DESCRIPTION OF READER COMMANDS............................12
8. DESCRIPTION OF EDITOR COMMANDS............................15
9. USERLIST..................................................17
10. CARBON COPIES............................................17
11. FLAGS....................................................18
12. TECNICAL NOTES...........................................19
MSGID...................................................19
PID and Tear line.......................................19
Technical support.......................................19
Page i
WEdit 2.0 - Copyright 1991 Franco Schinco 12/04/91
Memory requirement......................................19
Unregistered copies.....................................19
Errorlevel..............................................19
Macro Editor............................................20
QuickBBS files sharing..................................20
File selection window...................................20
Selection window at first/last message in area..........20
AREAS.PRM...............................................20
Page ii
WEdit 2.0 - Copyright 1991 Franco Schinco 12/04/91
1. INTRODUCTION
WEdit is a new message editor, in Fido or RemoteAccess/QuickBBS
format. Compactness and ease of use make WEdit suitable both for
point and for SysOps which need a standalone editor to answer
messages without making a local call to their Bbs.
Its main characteristics:
- support for Fido compatible message base
- support for QuickBBS compatible message base
- max length of messages set to 300 KB
- support for message base sharing
- window graphic interface
- DesqView awareness
- full usage of nodelist compiled by WNode
- installation driven by a window SetUp
- support for Akas and Domains, definable in each area
- smart quoting
- search for new messages addressed to user
- direct support for FrontDoor and RemoteAccess folders files
- use of WMail AREAS.PRM areas file
~~~~~~~~
This user manual assumes basic knowledge of Bbs/Point management:
otherwise, please refer to the documentation enclosed in mailers
user for EchoMail transmission and in Bbs management programs.
Page 1
WEdit 2.0 - Copyright 1991 Franco Schinco 12/04/91
2. THANKS
I would like to thank all beta testers for their help and
contribution in WEdit development: Ugo Uggetti, Andrea Mennini,
Massimo Gentilini, Marco Maccaferri, Cesare Dieni, Luca Leone,
Roberto Piola, Alberto Enna.
Special thanks are due to the following people:
- Stefania Falleni, tireless message writer, who
always gave me good estetic suggestions and a lot
of ideas during programming phase.
- Silvan Calarco, for his suggestions and help in
Turbo Pascal programming and as alpha tester.
- Franco Carcillo, who encouraged me in carring on
WEdit project.
- Maurizio Codogno, who wrote the coding algorithm
for the registration key, has been an alpha tester
and translated documentation into English [please,
flames about my knowledge of English to 2:334/100.5
or mau@bilbo.cselt.stet.it ;-) .mau.]
- ....all the people I forgot about and to whom I
address my most sincere Grazie!.....
Page 2
WEdit 2.0 - Copyright 1991 Franco Schinco 12/04/91
3. USAGE LICENSE
WEdit is not a public domain program. It is distributed as
Shareware: that is, after a trial period, the user has to
register his/her copy by sending the requested amount of money to
the author.
WEdit is not limited in life: even without registration it will
contiune to function. However, some minor functions are usable
only after registration, and received a software key. To
register WEdit, the user must compile and send to the address
written below the module included in the distribution archive;
moreover, a payment has to be made through an International Money
Order addressed to the author. Registration key will be valid for
all present and future version of WEdit.
Whoever can redistribute the sharewre version of WEdit, provided
that it remains in the original package and that no amount of
money is asked for it. In no circumstance at all WEdit can be
modified without author's permission; it is forbidden too to
include even part of this program in other software. It is
explicity prohibited to give to other people the personal
registration key.
WEdit can be used in commercial organization only after regular
registration.
This license is considered implicitly accepted if program is
used; its violation will involve lose of registration key and of
usage rights for the program.
No WEdit sources, in whatever version, will be released.
In no case author shall be liable because of data loss or other
relative to the use of WEdit; no guarantee is given on correct
functioning of program, except for space occupation on disk.
If someone finds problems in using WEdit, please refer them to
2:334/100.0 : time allowing, all will be answered.
Franco Schinco, FidoNet 2:334/100.0
C.so G. Agnelli 22
10137 TORINO
ITALY
Page 3
WEdit 2.0 - Copyright 1991 Franco Schinco 12/04/91
4. INSTALLATION
In WEdit distribution archive, the following files have been
included:
WEDIT.EXE Executable program
WEDIT.OVR Overlay module
WEDSETUP.EXE Configuration program
WNODE.EXE Nodelist compiler
WNODE.CTL Configuration file for WNode
WEDIT.DOC Documentation
WNODE.DOC WNode user's manual
REGISTER.FRM Registration module
HISTORY.DOC History of WEdit versions
To install WEdit:
1) Uncompact WEDIT.EXE , WEDIT.OVR and WEDSETUP.EXE in the
directory in which the mailer can be found.
2) Run WEDSETUP.EXE and configurate WEdit in a way suitable for
your system.
3) Add to Bbs management batch file the following line:
SET WEdit=path
where path is the directory in which WEdit will search for
configuration files.
Page 4
WEdit 2.0 - Copyright 1991 Franco Schinco 12/04/91
5. CONFIGURATION
WEdit gets informations relative to system configuration from a
file called WEDIT.PRM and located in the directory pointed by the
environment variable WEDIT; areas definition is contained in file
AREAS.PRM (used also by WMail, EchoMail processor by Silvan
Calarco, version 2.2 or above), located in the directory pointed
by environment variables WEDIT or WMAIL. If neither variable is
found, WEdit will search for configuration files in the current
directory.
Both files are created by WEDSETUP.EXE .
Use of WEDSETUP.EXE
File
* Prog. Info
Shows a screenful of program identification.
* Write to
Writes current configuration into a text file.
* DOS Shell
Lets the user temporarily spawn a shell out of WEDSETUP.EXE .
* Exit
Ends WEDSETUP.EXE and save WEDIT.PRM and AREAS.PRM .
Page 5
WEdit 2.0 - Copyright 1991 Franco Schinco 12/04/91
Global
* Key
Specifies the number of registration key; if you did not
registrate your copy of WEdit, leave this field blank.
* User
Specifies the name (and surname) which will be used to insert
messages.
* Address - Main
Specifies primary address assigned to node or point. If no
address was assigned, DO NOT invent one! Ask rather your
nearer Net coordinator to give you one. A fake or not
standard node number can cause serious problems to EchoMail
distribution net.
* Address - Aka 1-10
Specifies all secondary matrix addresses, if assigned.
* Domain
Lets the user associate up to 20 domains to as many as zones;
WEdit will insert the right domain (in message origin and
MSGID) by comparing the zone of the address used for current
area with the ones defined here.
* Directories - Msg Base
Specificies path in which WEdit will search for files
MSG*.BBS, relative to data base in QuickBBS format. This is
necessary only if some area is specified in this format.
Final backslash can be omitted.
* Directories - UserList
Specifies primary and secondary Userlist (in Parselst format)
to be used to find addresses in NetMail messages.
Page 6
WEdit 2.0 - Copyright 1991 Franco Schinco 12/04/91
* Directories - Nodelist
Specifies path in which WEdit will search for nodelist files
compiled by WNode.
* Directories - Swap
Specifies path in which WEdit will put disk swap file.
* Directories - TossLog
Specifies file in which WEdit will write tags of EchoMail
areas in which messages have been inserted.
* Directories - EchoFile
Specifies areas file (usually AREAS.BBS) from which WEdit can
optionally get informations about areas.
Origin
* Origin 1 - 10
Specifies lines to be inserted as Origin mail in Echomail
messages without it. Each of this line, plus the address
automatically inserted by WEdit at their end, should not
exceed 79 characters.
Page 7
WEdit 2.0 - Copyright 1991 Franco Schinco 12/04/91
Area
WEdSetup can import areas definition directly from FOLDER.SYS of
FrontDoor 1.99c, FOLDER.FD of FrontDoor 2.02 and MESSAGES.RA of
RemoteAccess 1.0 - 1.10 .
* Area - Title
Specifies title assigned to current area.
* Area - Path/Board
Specifies area path, if in Fido format, or board, if in
QuickBBS format. WEdit selects area type by seeing if the
field contains a path or a number.
* Area - Kind
Let the user select area type: Local, EchoMail or NetMail.
* Area - Default Attributes
Lets the user select default attributes of messages which
will be put in the current area.
* Area - Aka
Lets the user select which Aka, among those defined, has to
be used in current area.
* Area - Origin
Lets the user associate to current (EchoMail) area one of the
10 defined origins.
* Area - Tag
Specifies (EchoMail) area tag.
Page 8
WEdit 2.0 - Copyright 1991 Franco Schinco 12/04/91
Miscellaneous
* Macro 1 - 10
Lets the user define macros associated to editor keys F1 -
F10.
* Shell 1 - 10
Lets the user define shells associated to reader keys F1 -
F10 .
* Swap
Tells WEdit to transfer on disk or EMS most of its code,
during shells to DOS or external programs.
If EMS swap is selected, but there is not enough free MES
memory, WEdit will eventually swap to disk.
* Scan Areas
Tells WEdit to scan at the beginning of execution for unread
messages.
* No Sound
Tells WEdit not to do any sound.
* Use Domains
If put to `Yes', WEdit will insert domain in every message
MSGID and in every origin of EchoMail messages.
* Translate
If put to `Yes', WEdit will show, in QuickBBS areas,
progressive message number instead of the real one in message
base.
Page 9
WEdit 2.0 - Copyright 1991 Franco Schinco 12/04/91
* Tear line
If set to 'Yes', WEdit will insert its signature in echomail
messages tear line.
* PID line
If set to 'Yes', WEdit will insert a Product Identification
line in every message.
* Upcase Name
If set to 'Yes' WEdit will capitalize receiver's name
initials.
* Quote Line
Lets the user define intestation line which precedes answers
quoting original message. The following macros can be used:
%% = a single `%'
%a = Quoted message sender address
%d = Quoted message writing date
%f = Quoted message sender complete name
%h = Quoted message writing hour
%n = Quoted message sender first name
%t = Quoted message receiver
Page 10
WEdit 2.0 - Copyright 1991 Franco Schinco 12/04/91
6. EXECUTION
Command line syntax is:
WEDIT [-B] [-H]
Description of switches:
-B : forces WEdit to use BIOS for video writing. Usually,
WEdit writes directly on video memory, and with the
least snow effect possible on CGA graphic cards. The
use of this switch is recommended if problem of
concurrent video access are present while using
multitaskers. BIOS video access is slower than direct
one.
NOTE: BIOS video writing is always active if
WEdit is used under DesqView.
-H : shows a quick help about possible switches.
Page 11
WEdit 2.0 - Copyright 1991 Franco Schinco 12/04/91
7. DESCRIPTION OF READER COMMANDS
Alt-A Lets the user select another message area among
those defined.
Alt-B Shows the list of QuickBBS message base boards,
with the number of current messages and the
name associated to that board in area
definition.
This function can be used only if QuickBBS
message base path has been specified. (+)
Alt-C Lets the user modify current message.
Alt-D or Del Lets the user cancel, after confirmation,
current message.
Alt-E or Insert Lets the userintroduce a new message.
Alt-F Activates search on area message headers of a
specified string.
Alt-H Shows an help of active command in Reader mode.
Alt-I Shows a series of ionformation about current
area. It is also shown the available memory,
which coincide with the maximum length of a
message that WEdit can read.
Alt-K Activates `Read-Only' bit on the file of the
current message. This function is active only
in Fido format. (+)
Alt-L Shows the list of areas messages. In NetMail
areas, origin and destination addresses of the
message highlighted by selection bar are
visualized too.
Alt-M Lets the user Copy/Move/Forward current message
to whichever defined area.
Alt-O Shell to Dos.
Alt-P Prints on PRN: current message.
Alt-Q Lets the user answer current message by quoting
text.
Page 12
WEdit 2.0 - Copyright 1991 Franco Schinco 12/04/91
Alt-R Lets the user answer current message.
Alt-S Scans all defined areas to search for unread
messages. Areas containing unread messages are
highlighted in the list by putting a (red)
square as first character in line.
Alt-V Toggles visualization of lines hidden by a ^A
(kludge lines).
Alt-W Lets the user save message in a text file.
Alt-X Ends WEdit execution, after confirmation.
Alt-Y Searches in all areas for messages addressed to
the person specified in setup file as User. (+)
Alt-Z Gives informations about WEdit.
F1-F10 Runs shells associated to function keys. (+)
^E Lets the user write a new message, selecting
destination area.
^Q Lets the user answer to current message by
quoting text and choosing destination area.
^R Lets the user answer to current message while
choosing destination area.
Left Goes to previous message. If currently on
first area message, WEdit will ask whether to
go to previous area.
Right Goes to following message. If currently on
last area message, WEdit will ask whether to
go to following area.
Up Scrolls text one line up.
Down Scrolls text one line down.
PgUp Scrolls text 15 lines up.
PgDn or Space Scrolls text 15 lines down.
Page 13
WEdit 2.0 - Copyright 1991 Franco Schinco 12/04/91
Home Jumps to the first area message.
End Jumps to the last message read in area.
^Left Jumps to the previous message in a reply chain.
^Right Jumps to the following message in a reply
chain.
0..9 Lets the user jump to the specified message
number.
Tab Jump to following message found with Alt-Y (+)
Shift-Tab Jump to previous message found with Alt-Y (+)
Page 14
WEdit 2.0 - Copyright 1991 Franco Schinco 12/04/91
8. DESCRIPTION OF EDITOR COMMANDS
Alt-A Recalls ASCII table. (+)
Alt-F Formats the whole text.
Alt-G Lets the user change the origin associated to
the current area.
Alt-H Shows an help of active command in Editor mode.
Alt-I Imports an ASCII file in text.
Alt-O Shell to Dos.
Alt-P Prints on PRN: message text.
Alt-Q Imports an ASCII file in text, as a quotation.
Alt-S o ^Z Saves message.
Alt-U Lets the user select in the buffer of lines
deleted with ^Y those to be taken again. (+)
Alt-W Writes message text on a text file.
F1-F10 Inserts in text macros associated to function
keys.
Esc Lets the user abandon message, after
confirmation.
Left Moves the cursor towards left.
Right Moves the cursor towards right.
Up Moves the cursor towards up.
Down Moves the cursor towards down.
PgUp Moves the cursor 15 lines towards up.
PgDn Moves the cursor 15 lines towards down.
Home Moves the cursor to the beginning of line.
End Moves the cursor to the end of line.
^Left Moves the cursor one word to the left.
^Right Moves the cursor one word to the right.
Page 15
WEdit 2.0 - Copyright 1991 Franco Schinco 12/04/91
^PgUp Moves the cursor to the beginning of text.
^PgDn Moves the cursor to the end of text.
^F Formats the current paragraph.
^U Undeletes last line deleted with ^Y.
^Y Deletes a line.
^Home Deletes current line from cursor to end.
^End Deletes text from current line to end of
message.
Tab Is converted to 8 spaces.
Backspace Deletes character to the left of cursor.
Del Deletes character to the right of cursor.
Ins Toggle overwriting of text.
Page 16
WEdit 2.0 - Copyright 1991 Franco Schinco 12/04/91
9. USERLIST
WEdit can use userlist produced by Parselst or equivalent; for a
better address management, it is recommended to use nodelist
compiled by WNode. If both kind of files are found, WEdit will
use those created by WNode; to force use of Parselst userlist,
simply do not specify nodelist path in Setup.
During selection of destination address it is possible to get
information about highlighted node by hitting Space.
10. CARBON COPIES
WEdit considers every line starting with CC: an instruction of
Carbon Copy, that is a copy of the message will be sent to the
receiver specified after CC:.
To let CC be used also in messages to other domains, WEdit
ignores CC: lines put after any gateways routing line, starting
with To: .
On CC: line it is possible to specify receiver either with
his/her address, or with name and surname; WEdit can however
translate the latter to an address only if a userlist is used.
More than one receiver can be specified on a line, separated with
commas, up to the end of physical line; for each message, a
maximum of 255 carbon copies is allowed.
Ex.
CC: Franco Carcillo, 2:334/104, Piola
CC: 334/102.5
As the example shows, it is possible to specify just a part of
the receiver name.
If the address is used, WEdit will send the message to `Sysop'.
Carbon Copy function is active *only* on new messages, and it is
possible to use it in all kind of areas.
Page 17
WEdit 2.0 - Copyright 1991 Franco Schinco 12/04/91
11. FLAGS
WEdit can signal activation of all standard flags associated to a
message. In Edit mode, however, only the following can be
activated:
■ Private
■ Crash
■ Attach
■ Kill/Sent
■ Hold
■ Request
■ Update Request
■ Return Receipt Request
■ Sent
The following extended flags are supported too:
■ Direct
■ Truncate File Sent
■ Kill File Sent
■ Immediate
Page 18
WEdit 2.0 - Copyright 1991 Franco Schinco 12/04/91
12. TECNICAL NOTES
* MSGID
WEdit inserts MSGID in every message.
* PID and Tear line
WEdit will allow you to insert both PID and Tear line signature;
however I recommend to insert only one of the two options in
order to save message length.
Please, note that at least one of the two options *must* be set
to 'Yes'.
* Technical support
An ECHO conference on node 2:334/100.0 is activated, with tag
WMAIL.334, for discussion about W*.* products; to get it, please
contact sysop of 2:334/100.0 .
* Memory requirement
WEdit can run in 300 Kb; available memory determinates the
maximum length of a message which WEdit can read. In every case,
the maximum length of a message is 4000 lines, i.e. about 300 Kb.
* Unregistered copies
If WEdit is used without registration key, the functions labelled
with (+) will not be active.
* Errorlevel
WEdit will exit with the following errorlevels:
0 : no message introduced
1 : fatal initialization error
2 : messages introduced in local areas
3 : messages introduced in echomail areas
4 : messages introduced in netmail areas
If messages are introduced in areas of different type, the
errorlevel will be set as the sum of the single ones. For
example, if Echomail and Netmail messages were written, WEdit
will exit with errorlevel 7.
Page 19
WEdit 2.0 - Copyright 1991 Franco Schinco 12/04/91
* Macro Editor
In editor macros, pipe character (`|', Alt-124) is equivalent to
a CR-LF .
* QuickBBS files sharing
WEdit can share QuickBBS message base files with other programs;
during writing of message base, WEdit will not allow access to
these file for the time necessary to the operation, then it will
release access again. To let this work, SHARE.EXE must be
installed, otherwise it is possible that WEdit and other programs
do a concurrent access, with danger of corruption of the message
base.
NOTE: To read any message written by other programs in the area
in which WEdit is currently in, it is necessary to change
area and then moving again to the original one.
* File selection window
In messages with flag File Attach or Update Request, WEdit will
show a window to select file to be sent or to be updated; it is
possible to select more than one file, even in different path,
provided that the total length of the string which contains file
names is below 71 characters, physical limit for Subject field in
messages.
* Selection window at first/last message in area
If the user tries to read after last or before first message of
an area, WEdit shows a selection window, by means of which it is
possible to go to the following or the previous area, to go to
the next area with unread messaged (provided that an area scan
with Alt-S was made) or even to select an area among those
defined.
* AREAS.PRM
Next WMail release (2.2) will be able to use theis file instead
of usual AREAS.BBS, cutting so configuration times.
Even if WMail and WEdit use the same file, it is anyhow necessary
to run both setups to define area fields not shared by the two
programs. Currently, WEdit and WMail share Name, Path/Board and
Tag of the areas.
Areas shown by WEDSETUP as `WMail Passthru Area' cannot be
edited: they can however be moved or copied in other position.
** End of Documentation **
Page 20